Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Spell Checker #1168

Merged
merged 29 commits into from
Nov 22, 2023
Merged

Add Spell Checker #1168

merged 29 commits into from
Nov 22, 2023

Conversation

bpaul4
Copy link
Contributor

@bpaul4 bpaul4 commented Sep 21, 2023

Summary/Motivation:

Adds spell checker to CI test runs.

Changes proposed in this PR:

  • Add CI setup necessary to run spell checker on PR runs

  • Initial configuration file with some known file type exceptions; comments lists all other (included) file types for reference

  • Open questions: 1) what file types should be included/excluded? 2) what known "misspellings" should be excepted, e.g. "IDAES"? 3) should we mandate that the pylint and docs checks wait on the spell-check and code-formatting (black), like pytest does?

  • Locally, navigating to the FOQUS/ directory, installing typos and running typos --files will list all files that are checked. Running typos --config ./.github/workflows/typos.toml will run the spell check using the configuration file.

  • Note: the Check Spelling test will fail for now, as we haven't actually corrected the spelling errors yet

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the copyright and license terms described in the LICENSE.md file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@bpaul4 bpaul4 self-assigned this Sep 21, 2023
@bpaul4 bpaul4 mentioned this pull request Sep 19, 2023
6 tasks
@ksbeattie ksbeattie added the Priority:High High Priority Issue or PR label Sep 26, 2023
@lbianchi-lbl
Copy link
Contributor

lbianchi-lbl commented Nov 21, 2023

@sotorrio1 the one remaining word flagged as an error is an instance of "ghostOuput" here:

That part seems to be related to PSUADE (i.e. writing the PSUADE input file), so I wanted to double-check if "ghostOuput" is a misspelling of "ghostOutput", or it's actually the correct string in the context of the PSUADE input file syntax.

@sotorrio1
Copy link
Member

@lbianchi-lbl I'm pretty sure this is just a misspelling of "ghostOutput". It's only naming that variable "ghostOuput" in the case there are no outputs (all the variables are inputs). I've even tested the method generateSamples changing it to the correct spelling (ghostOutput) and it works fine. PSUADE is not looking for that specific (and wrong) string lol

@lbianchi-lbl lbianchi-lbl marked this pull request as ready for review November 22, 2023 00:15
Copy link

codecov bot commented Nov 22, 2023

Codecov Report

Attention: 42 lines in your changes are missing coverage. Please review.

Comparison is base (5334847) 37.25% compared to head (143fec1) 37.10%.

Files Patch % Lines
foqus_lib/framework/surrogate/ALAMO.py 0.00% 7 Missing ⚠️
foqus_lib/framework/uq/RSAnalyzer.py 0.00% 5 Missing ⚠️
foqus_lib/framework/optimizer/NLopt.py 0.00% 4 Missing ⚠️
foqus_lib/framework/optimizer/Snobfit.py 0.00% 4 Missing ⚠️
foqus_lib/framework/optimizer/SM_Optimizer.py 0.00% 3 Missing ⚠️
foqus_lib/framework/pymodel/heat_integration.py 0.00% 3 Missing ⚠️
foqus_lib/framework/sim/turbineConfiguration.py 0.00% 3 Missing ⚠️
foqus_lib/framework/graph/nodeVars.py 0.00% 2 Missing ⚠️
foqus_lib/foqus.py 0.00% 1 Missing ⚠️
foqus_lib/framework/graph/graph.py 50.00% 1 Missing ⚠️
... and 9 more
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1168      +/-   ##
==========================================
- Coverage   37.25%   37.10%   -0.15%     
==========================================
  Files         160      160              
  Lines       36396    36396              
  Branches     5956     5956              
==========================================
- Hits        13558    13504      -54     
- Misses      21750    21794      +44     
- Partials     1088     1098      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lbianchi-lbl lbianchi-lbl merged commit 250ee8c into CCSI-Toolset:master Nov 22, 2023
16 of 18 checks passed
@bpaul4 bpaul4 deleted the spell-checking branch May 1, 2024 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority:High High Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Spellchecker to CI checks
4 participants